<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
    <link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
    <link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
    <link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
    <link href="stable/static/css/api.css" rel="stylesheet" type="text/css">
    <title>chrome.debugger - chrome插件中文开发文档(非官方)</title>
  </head>
  <body>
    <a id="top"></a>
    <div id="header">{Header content}</div>
    <a id="gc-topnav-anchor"></a>
    <div id="gc-topnav">
      <h1>Google Chrome Extensions</h1>
      <ul id="home" class="gc-topnav-tabs">
        <li id="home_link">
          <a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
        </li>
        <li id="docs_link">
          <a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
        </li>
        <li id="faq_link">
          <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
        </li>
        <li id="samples_link">
          <a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
        </li>
        <li id="group_link">
          <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
        </li>
        <li id="so_link">
          <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
        </li>
      </ul>
    </div>
    <div id="gc-container">
      <div id="gc-sidebar">
        <ul 
            class="level1 ">
          <li class="level2">
                <a href="getstarted.html" class="level2 ">Getting Started</a>
          </li>
          <li class="level2">
                <a href="overview.html" class="level2 ">Overview</a>
          </li>
          <li class="level2">
                <a href="whats_new.html" class="level2 ">What's New?</a>
          </li>
          <li class="level2">
                <a href="devguide.html" class="level2 ">Developer's Guide</a>
              <ul 
                  class="level2 ">
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Browser UI</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="browserAction.html" class="level4 ">Browser Actions</a>
                      </li>
                      <li class="level4">
                            <a href="contextMenus.html" class="level4 ">Context Menus</a>
                      </li>
                      <li class="level4">
                            <a href="notifications.html" class="level4 ">Desktop Notifications</a>
                      </li>
                      <li class="level4">
                            <a href="omnibox.html" class="level4 ">Omnibox</a>
                      </li>
                      <li class="level4">
                            <a href="options.html" class="level4 ">Options Pages</a>
                      </li>
                      <li class="level4">
                            <a href="override.html" class="level4 ">Override Pages</a>
                      </li>
                      <li class="level4">
                            <a href="pageAction.html" class="level4 ">Page Actions</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Browser Interaction</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="bookmarks.html" class="level4 ">Bookmarks</a>
                      </li>
                      <li class="level4">
                            <a href="cookies.html" class="level4 ">Cookies</a>
                      </li>
                      <li class="level4">
                            <a href="devtools.html" class="level4 ">Developer Tools</a>
                      </li>
                      <li class="level4">
                            <a href="events.html" class="level4 ">Events</a>
                      </li>
                      <li class="level4">
                            <a href="history.html" class="level4 ">History</a>
                      </li>
                      <li class="level4">
                            <a href="management.html" class="level4 ">Management</a>
                      </li>
                      <li class="level4">
                            <a href="tabs.html" class="level4 ">Tabs</a>
                      </li>
                      <li class="level4">
                            <a href="windows.html" class="level4 ">Windows</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Implementation</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="a11y.html" class="level4 ">Accessibility</a>
                      </li>
                      <li class="level4">
                            <a href="event_pages.html" class="level4 ">Event Pages</a>
                      </li>
                      <li class="level4">
                            <a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
                      </li>
                      <li class="level4">
                            <a href="content_scripts.html" class="level4 ">Content Scripts</a>
                      </li>
                      <li class="level4">
                            <a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
                      </li>
                      <li class="level4">
                            <a href="i18n.html" class="level4 ">Internationalization</a>
                      </li>
                      <li class="level4">
                            <a href="messaging.html" class="level4 ">Message Passing</a>
                      </li>
                      <li class="level4">
                            <a href="permissions.html" class="level4 ">Optional Permissions</a>
                      </li>
                      <li class="level4">
                            <a href="npapi.html" class="level4 ">NPAPI Plugins</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Finishing</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="hosting.html" class="level4 ">Hosting</a>
                      </li>
                      <li class="level4">
                            <a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
                      </li>
                    </ul>
                </li>
              </ul>
          </li>
          <li class="level2">
                <a href="tutorials.html" class="level2 ">Tutorials</a>
              <ul 
                  class="level2 ">
                <li class="level3">
                      <a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
                </li>
                <li class="level3">
                      <a href="tut_debugging.html" class="level3 ">Debugging</a>
                </li>
                <li class="level3">
                      <a href="tut_analytics.html" class="level3 ">Google Analytics</a>
                </li>
                <li class="level3">
                      <a href="tut_oauth.html" class="level3 ">OAuth</a>
                </li>
              </ul>
          </li>
          <li class="level2">
                <span class="level2">Reference</span>
              <ul 
                  class="level2 ">
                <li class="level3">
                    <a class="button level3">
                      <span class="level3">Formats</span>
                      <div class="toggleIndicator level3"></div>
                    </a>
                    <ul toggleable
                        class="level3 hidden">
                      <li class="level4">
                            <a href="manifest.html" class="level4 ">Manifest Files</a>
                      </li>
                      <li class="level4">
                            <a href="match_patterns.html" class="level4 ">Match Patterns</a>
                      </li>
                    </ul>
                </li>
                <li class="level3">
                      <a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
                </li>
                <li class="level3">
                      <a href="api_index.html" class="level3 ">chrome.* APIs</a>
                </li>
                <li class="level3">
                      <a href="api_other.html" class="level3 ">Other APIs</a>
                </li>
              </ul>
          </li>
          <li class="level2">
                <span class="level2">More</span>
              <ul 
                  class="level2 ">
                <li class="level3">
                      <a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
                </li>
                <li class="level3">
                      <a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
                </li>
                <li class="level3">
                      <a href="themes.html" class="level3 ">Themes</a>
                </li>
              </ul>
          </li>
        </ul>
      </div>
      <div id="gc-pagecontent">
        <h1 class="page_title">chrome.debugger</h1>
        
        
        
        <div id="toc">
          <h2>Contents</h2>
          <ol>
            <li>
              <a href=#manifest>Notes</a>
            </li>
            <li>
              <a href=#manifest>Manifest</a>
            </li>
            <li>
              <a href=#examples>Examples</a>
            </li>
            <li>
              <a href="#apiReference">API reference: chrome.debugger</a>
              <ol>
                  <li><a href="#types">Types</a><ol>  <li>    <a href="#type-Debuggee">Debuggee</a>  </li></ol></li>
                  
                  <li><a href="#methods">Methods</a><ol>  <li><a href="#method-attach">attach</a></li>  <li><a href="#method-detach">detach</a></li>  <li><a href="#method-sendCommand">sendCommand</a></li></ol></li>
                  <li><a href="#events">Events</a><ol>  <li><a href="#event-onEvent">onEvent</a></li>  <li><a href="#event-onDetach">onDetach</a></li></ol></li>
                  <li><a href="#samples">Sample Extensions</a></li>
              </ol>
            </li>
          </ol>
        </div>

<h2 id="manifest">Notes</h2>

<p>
Debugger API serves as an alternate transport for Chrome's
<a href="http://code.google.com/chrome/devtools/docs/remote-debugging.html">
remote debugging protocol</a>. Use <code>chrome.debugger</code>
to attach to one or more tabs to instrument network interaction, debug
JavaScript, mutate the DOM  and CSS, etc. Use the Debuggee tabId to target tabs
with sendCommand and route events by <code>tabId</code> from onEvent callbacks. 
</p>

<p>
As of today, attaching to the tab by means of the debugger API
and using embedded Chrome DevTools with that tab are mutually exclusive.
If user invokes Chrome DevTools while extension is attached to the tab,
debugging session is terminated. Extension can re-establish it later.
</p>

<h2 id="manifest">Manifest</h2>

<p>
You must declare the "debugger" permission in your extension's manifest
to use this API.
</p>

<pre>{
  "name": "My extension",
  ...
<b>  "permissions": [
    "debugger",
  ]</b>,
  ...
}</pre>


<h2 id="examples">Examples</h2>

<p>
You can find samples of this API in
<a href="samples.html#debugger">Samples</a>.
</p>
        <h2 id="apiReference">API Reference: chrome.debugger</h2>
        <div class="api_reference">
            <h3 id="types">Types</h3>
              <div>
                <h3 id="type-Debuggee">Debuggee</h3>
                <div>
                  <dt><span class="type_name">  (    <span id="typeTemplate">object</span>  )</span></dt>
              <dd>
                    Debuggee identifier.
                  </dd>    <h4 id="Debuggee-properties">
                    Properties of <a href="#type-Debuggee">Debuggee</a>
                  </h4>
                  <dd><dl>      <div>
                      <a name="property-Debuggee-tabId"></a>
                      <dt>
                        <span class="variable">tabId</span>
                        <span class="property">
                          (
                            
                            <span id="typeTemplate">integer</span>
                          )
                        </span>
                      </dt>
                      <dd>
                        The id of the tab which you intend to debug.
                      </dd>
                    </div>
              </dl></dd>
                </div>
              </div>
            <h3 id="methods">Methods</h3>
              <div>
                <h4 id="method-attach">attach</h4>
                <div class="summary lower">
                  <span>chrome.debugger.attach</span>(<span><a href="debugger.html#type-Debuggee">Debuggee</a> <span class="variable">target</span></span>, <span>string <span class="variable">requiredVersion</span></span>)
                </div>
                <div class="description">
              <p>
                    Attaches debugger to the given target.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-attach-target"></a>  <dt>    <span class="variable">target</span>    <span class="property">      (                <span id="typeTemplate"><a href="debugger.html#type-Debuggee">Debuggee</a></span>      )    </span>  </dt>  <dd>    Debugging target to which you want to attach.  </dd></div><div>  <a name="property-attach-requiredVersion"></a>  <dt>    <span class="variable">requiredVersion</span>    <span class="property">      (                <span id="typeTemplate">string</span>      )    </span>  </dt>  <dd>    Required debugging protocol version ("0.1"). One can only attach to the debuggee with matching major version and greater or equal minor version. List of the protocol versions can be obtained <a href='http://code.google.com/chrome/devtools/docs/remote-debugging.html'>here</a>.  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      If you specify the <em>callback</em> parameter, it should      specify a function that looks like this:</p><pre>function() <span class="subdued">{...}</span>;</pre><dl>  </dl>
                </div>
              </div>
              <div>
                <h4 id="method-detach">detach</h4>
                <div class="summary lower">
                  <span>chrome.debugger.detach</span>(<span><a href="debugger.html#type-Debuggee">Debuggee</a> <span class="variable">target</span></span>)
                </div>
                <div class="description">
              <p>
                    Detaches debugger from the given target.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-detach-target"></a>  <dt>    <span class="variable">target</span>    <span class="property">      (                <span id="typeTemplate"><a href="debugger.html#type-Debuggee">Debuggee</a></span>      )    </span>  </dt>  <dd>    Debugging target from which you want to detach.  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      If you specify the <em>callback</em> parameter, it should      specify a function that looks like this:</p><pre>function() <span class="subdued">{...}</span>;</pre><dl>  </dl>
                </div>
              </div>
              <div>
                <h4 id="method-sendCommand">sendCommand</h4>
                <div class="summary lower">
                  <span>chrome.debugger.sendCommand</span>(<span><a href="debugger.html#type-Debuggee">Debuggee</a> <span class="variable">target</span></span>, <span>string <span class="variable">method</span></span>, <span class="optional">object <span class="variable">commandParams</span></span>)
                </div>
                <div class="description">
              <p>
                    Sends given command to the debugging target.
                  </p>    <h4>Parameters</h4>
                  <dl>
                    <div>  <a name="property-sendCommand-target"></a>  <dt>    <span class="variable">target</span>    <span class="property">      (                <span id="typeTemplate"><a href="debugger.html#type-Debuggee">Debuggee</a></span>      )    </span>  </dt>  <dd>    Debugging target to which you want to send the command.  </dd></div><div>  <a name="property-sendCommand-method"></a>  <dt>    <span class="variable">method</span>    <span class="property">      (                <span id="typeTemplate">string</span>      )    </span>  </dt>  <dd>    Method name. Should be one of the methods defined by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging.html'>remote debugging protocol</a>.  </dd></div><div>  <a name="property-sendCommand-commandParams"></a>  <dt>    <span class="variable">commandParams</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    JSON object with request parameters. This object must conform to the remote debugging params scheme for given method.  </dd></div>
                  </dl>
                  <h4>Callback function</h4><p>      If you specify the <em>callback</em> parameter, it should      specify a function that looks like this:</p><pre>function(object result) <span class="subdued">{...}</span>;</pre><dl>  <div>  <a name="property-callback-result"></a>  <dt>    <span class="variable">result</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    JSON object with the response. Structure of the response varies depending on the method and is defined by the remote debugging protocol.  </dd></div></dl>
                </div>
              </div>
            <h3 id="events">Events</h3>
              <div>
                <h4 id="event-onEvent">onEvent</h4>
                <div class="summary">
                  <span class="subdued">chrome.debugger.</span>onEvent<span class="subdued">.addListener</span>(function(<span><a href="debugger.html#type-Debuggee">Debuggee</a> <span class="variable">source</span></span>, <span>string <span class="variable">method</span></span>, <span class="optional">object <span class="variable">params</span></span>)<span class="subdued"> {...}</span>);
                </div>
                <div class="description">
              <p>
                    Fired whenever debugging target issues instrumentation event.
                  </p>      <h4>Listener Parameters</h4>
                    <dl>
                      <div>  <a name="property-onEvent-source"></a>  <dt>    <span class="variable">source</span>    <span class="property">      (                <span id="typeTemplate"><a href="debugger.html#type-Debuggee">Debuggee</a></span>      )    </span>  </dt>  <dd>    The debuggee that generated this event.  </dd></div><div>  <a name="property-onEvent-method"></a>  <dt>    <span class="variable">method</span>    <span class="property">      (                <span id="typeTemplate">string</span>      )    </span>  </dt>  <dd>    Method name. Should be one of the notifications defined by the <a href='http://code.google.com/chrome/devtools/docs/remote-debugging.html'>remote debugging protocol</a>.  </dd></div><div>  <a name="property-onEvent-params"></a>  <dt>    <span class="variable">params</span>    <span class="property">      (        <span class="optional">optional</span>        <span id="typeTemplate">object</span>      )    </span>  </dt>  <dd>    JSON object with the response. Structure of the response varies depending on the method and is defined by the remote debugging protocol.  </dd></div>
                    </dl>
                </div>
              </div>
              <div>
                <h4 id="event-onDetach">onDetach</h4>
                <div class="summary">
                  <span class="subdued">chrome.debugger.</span>onDetach<span class="subdued">.addListener</span>(function(<span><a href="debugger.html#type-Debuggee">Debuggee</a> <span class="variable">source</span></span>)<span class="subdued"> {...}</span>);
                </div>
                <div class="description">
              <p>
                    Fired when browser terminates debugging session for the tab. This happens when either the tab is being closed or Chrome DevTools is being invoked for the attached tab.
                  </p>      <h4>Listener Parameters</h4>
                    <dl>
                      <div>  <a name="property-onDetach-source"></a>  <dt>    <span class="variable">source</span>    <span class="property">      (                <span id="typeTemplate"><a href="debugger.html#type-Debuggee">Debuggee</a></span>      )    </span>  </dt>  <dd>    The debuggee that was detached.  </dd></div>
                    </dl>
                </div>
              </div>
        </div>
          <h2 id="samples">Sample Extensions that use chrome.debugger</h2>
            <li><strong><a href="samples.html#f447d4d0c667a4f72ef8c6190e7925d7">Live HTTP headers</a></strong> &ndash;
            Displays the live log with the http requests headers
        </li>
            <li><strong><a href="samples.html#812b7fe611113aedf0a394e9fbbfcce1">JavaScript pause/resume</a></strong> &ndash;
            Pauses / resumes JavaScript execution
        </li>
      </div>
    </div>
  </body>
  <script>
    window.bootstrap = {
      api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
          [{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
      branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
    };
  </script>
  <div id="gc-footer">
    <div class="text">
      <p>
        Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
        the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
        Attribution 3.0 License</a>, and code samples are licensed under the
        <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
      </p>
      <p>
        ©2012 Google
      </p>
      <script src="stable/static/js/branch.js" type="text/javascript"></script>
      <script src="stable/static/js/sidebar.js" type="text/javascript"></script>
      <script src="stable/static/js/prettify.js" type="text/javascript"></script>
      <script>
        (function() {
          // Auto syntax highlight all pre tags.
          var preElements = document.getElementsByTagName('pre');
          for (var i = 0; i < preElements.length; i++)
            preElements[i].classList.add('prettyprint');
          prettyPrint();
        })();
      </script>
      <div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
  
    </div>
  </div>
</html>
